Skip to main content
POST
/
catalogs
Create a catalog
curl --request POST \
  --url https://your_a2_service/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "metadata": {
    "brand": "<string>",
    "category": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "image_link": "<string>",
    "link": "<string>",
    "seller_name": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "schema": "creative.catalog",
  "source": "<string>"
}'
{
  "id": "",
  "metadata": {
    "brand": "<string>",
    "category": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "image_link": "<string>",
    "link": "<string>",
    "seller_name": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "schema": "creative.catalog",
  "source": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Base schema for catalog entries.

Provides core structure for catalog items including schema identification and metadata validation.

​
metadata
object
required

The metadata of catalog item.

The schema defined by schema field specifies the minimum required fields. Additional fields beyond the schema definition are allowed and will be preserved.

​
id
string
default:""

The ID of catalog item

​
schema
string
default:creative.catalog

The schema of catalog item.

Supported schema:

  • creative.catalog: CatalogMetadataSchema
Allowed value: "creative.catalog"
​
source
string | null

The source of catalog item

Response

Successful Response

Base schema for catalog entries.

Provides core structure for catalog items including schema identification and metadata validation.

​
metadata
object
required

The metadata of catalog item.

The schema defined by schema field specifies the minimum required fields. Additional fields beyond the schema definition are allowed and will be preserved.

​
id
string
default:""

The ID of catalog item

​
schema
string
default:creative.catalog

The schema of catalog item.

Supported schema:

  • creative.catalog: CatalogMetadataSchema
Allowed value: "creative.catalog"
​
source
string | null

The source of catalog item